Skip to content

Add explicit opt-in flags for activity/nexus bean auto-discovery in Spring Boot#2830

Merged
mjameswh merged 4 commits intomasterfrom
20260402-sdk-java-2780-activity-auto-discovery
Apr 8, 2026
Merged

Add explicit opt-in flags for activity/nexus bean auto-discovery in Spring Boot#2830
mjameswh merged 4 commits intomasterfrom
20260402-sdk-java-2780-activity-auto-discovery

Conversation

@mjameswh
Copy link
Copy Markdown
Contributor

@mjameswh mjameswh commented Apr 7, 2026 •
edited
Loading

Fixes #2780.

Problem

@ActivityImpl- and @NexusServiceImpl-annotated Spring beans were silently not registered with Temporal workers unless spring.temporal.workers-auto-discovery.packages was configured — even though that setting is only supposed to control workflow classpath scanning. The entire auto-discovery block (activities, nexus services, and workflows) was gated on packages != null in WorkersTemplate.createWorkers().

Solution

Separate the concerns with explicit opt-in flags under spring.temporal.workers-auto-discovery:

Property Type Default Description
register-activity-beans boolean false Register @ActivityImpl-annotated Spring beans with matching workers
register-nexus-service-beans boolean false Register @NexusServiceImpl-annotated Spring beans with matching workers
workflow-packages list — Packages to scan for @WorkflowImpl classes (replaces packages)
enable boolean false Convenience flag: registers all @WorkflowImpl, @ActivityImpl, and @NexusServiceImpl Spring-managed beans without package scanning

The enable: true flag covers the common case where all implementations are Spring-managed beans. For more control, register-activities and register-nexus-operations can be set independently, and workflow-packages handles classpath scanning for workflow classes that are not Spring beans.

Backward compatibility

The existing packages property is deprecated but fully preserved:

  • If set and non-empty, it implies register-activities: true, register-nexus-operations: true, and its entries are treated as workflow-packages.
  • Combining packages with any of the new properties throws IllegalStateException at startup with a clear migration message.

Changes

  • WorkersAutoDiscoveryProperties — new fields, deprecation logic, validation, computed accessors (isRegisterActivities(), isRegisterNexusOperations(), isRegisterWorkflowBeans(), getEffectiveWorkflowPackages())
  • WorkersTemplate — auto-discovery block rewritten to use the new property accessors independently; added autoDiscoverWorkflowBeans() for bean-based workflow discovery
  • WorkersPresentCondition — binds WorkersAutoDiscoveryProperties as a whole (was binding only packages), so the condition fires for any workers-auto-discovery configuration
  • application.yml (tests) — existing profiles migrated from packages: to workflow-packages: + explicit flags; legacy packages behavior tested via the new auto-discovery-by-task-queue-legacy profile
  • New tests: AutoDiscoveryActivitiesOnlyTest, AutoDiscoveryEnableTest, AutoDiscoveryByTaskQueueLegacyTest, AutoDiscoveryMixedPropertiesRejectedTest

@mjameswh mjameswh requested a review from a team as a code owner April 7, 2026 01:42
@mjameswh mjameswh marked this pull request as draft April 7, 2026 01:45
@mjameswh mjameswh mentioned this pull request Apr 7, 2026
Closed
@Quinn-With-Two-Ns
Copy link
Copy Markdown
Contributor

Quinn-With-Two-Ns commented Apr 7, 2026

For manual config the properties are like

spring.temporal:
  workers:
    - task-queue: your-task-queue-name
      name: your-worker-name # unique name of the Worker. If not specified, Task Queue is used as the Worker name.
      workflow-classes:
        - your.package.YourWorkflowImpl
      activity-beans:
        - activity-bean-name1

Given that I might change some of the names here like register-activities -> register-activitiy-beans

@Quinn-With-Two-Ns
Copy link
Copy Markdown
Contributor

Quinn-With-Two-Ns commented Apr 7, 2026

How will a user know packages is deprecated? Could we log a warning to let users know?

@mjameswh mjameswh force-pushed the 20260402-sdk-java-2780-activity-auto-discovery branch from e1e5413 to e790f32 Compare April 7, 2026 19:04
@mjameswh mjameswh marked this pull request as ready for review April 7, 2026 19:07
@mjameswh
Copy link
Copy Markdown
Contributor Author

mjameswh commented Apr 7, 2026 •
edited
Loading

How will a user know packages is deprecated? Could we log a warning to let users know?

Turns out Spring Boot has its own annotation for that purpose. I added it.

@donald-pinckney donald-pinckney mentioned this pull request Apr 7, 2026
Open
5 tasks
robzienert
robzienert approved these changes Apr 7, 2026
View reviewed changes
...in/java/io/temporal/spring/boot/autoconfigure/properties/WorkersAutoDiscoveryProperties.java Outdated
* <p>Classpath-scanning via {@link #workflowPackages} (for non-bean workflow classes) still
* requires explicit package configuration regardless of this flag.
*/
private final @Nullable Boolean enable;
Copy link
Copy Markdown

@robzienert robzienert Apr 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Should probably choose enabled instead of enable to follow more closely to general Spring ecosystem convention. This is just my Spring exposure, so if you've seen it more commonly expressed enable that'd be interesting to learn!

Copy link
Copy Markdown
Contributor Author

@mjameswh mjameswh Apr 8, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot for your input! After some search, enabled indeed seems more idiomatic to the Spring Boot community.

@mjameswh mjameswh merged commit 8716d22 into master Apr 8, 2026
18 checks passed
@mjameswh mjameswh deleted the 20260402-sdk-java-2780-activity-auto-discovery branch April 8, 2026 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Quinn-With-Two-Ns Quinn-With-Two-Ns Quinn-With-Two-Ns approved these changes

@maciejdudko maciejdudko maciejdudko approved these changes

+1 more reviewer

@robzienert robzienert robzienert approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Spring boot workers-auto-discovery - Workflow vs Activities

4 participants

@mjameswh @Quinn-With-Two-Ns @robzienert @maciejdudko